/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.api.error;

import java.util.List;


/**
 * An exception thrown when a problem is encountered running a script. The
 * messages produce by the exception (getMessage(), toString(), etc) are fully
 * localized and suitable for presentation to the user.
 */
public abstract class AxilEvaluationException extends AxilException {
	protected AxilEvaluationException() { }
	protected AxilEvaluationException(Throwable cause) {
		super(cause);
	}


	// TODO: Provide a mechanism to reduce the stack to only a handful of
	// unique entries when a stack overflow occurs because of infinite
	// recursion. This will likely mean reducing a stack of 200+ frames down
	// to a dozen or less.


	/**
	 * The stack trace for the script. The stack frames are listed in order from
	 * the starting point to the point at which execution halted.
	 *
	 * @return
	 * 	Returns the set of stack frames. The list returned may be empty if the
	 * 	execution issue occurred outside of the script source code.
	 */
	public abstract List<Frame> stack();
}
